<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Playbook - ScenarioViewController</title>
    <link rel="stylesheet" type="text/css" href="https://playbook-ui.github.io/playbook-ios/all.css" media="all" />
</head>
<body>
    <header>
        <a href="https://playbook-ui.github.io/playbook-ios">
            <strong>
                Playbook
            </strong>
            <span>Documentation</span>
        </a>
    </header>

    <!--
    <form class="search">
        <input type="search" placeholder="Search" />
    </form>
    -->

    <nav>
        <div class="wrapper">
            <h2>On This Page</h2>
            <ol><li><a href="#relationships">Relationships</a><ul><li><a href="#relationships">Conforms To</a></li></ul></li><li><a href="#initializers">Initializers</a><ul><li class="initializer"><a href="#scenarioviewcontroller.init(context:)">init(context:​)</a></li><li class="initializer"><a href="#scenarioviewcontroller.init(context:scenario:)">init(context:​scenario:​)</a></li><li class="initializer"><a href="#scenarioviewcontroller.init?(coder:)">init?(coder:​)</a></li></ul></li><li><a href="#properties">Properties</a><ul><li class="variable"><a href="#scenarioviewcontroller.context">context</a></li><li class="variable"><a href="#scenarioviewcontroller.scenario">scenario</a></li><li class="variable"><a href="#scenarioviewcontroller.contentviewcontroller">content​View​Controller</a></li><li class="variable"><a href="#scenarioviewcontroller.shouldstatusbarhidden">should​Status​Bar​Hidden</a></li><li class="variable"><a href="#scenarioviewcontroller.disablesendappearancetransition">disables​End​Appearance​Transition</a></li><li class="variable"><a href="#scenarioviewcontroller.prefersstatusbarhidden">prefers​Status​Bar​Hidden</a></li></ul></li><li><a href="#methods">Methods</a><ul><li class="function"><a href="#scenarioviewcontroller.endappearancetransition()">end​Appearance​Transition()</a></li></ul></li></ol>
        </div>
    </nav>

    <main>
        <article>
            <h1>
    <small>Class</small>
    <code class="name">Scenario​View​Controller</code>
</h1>

<div class="declaration">
<pre class="highlight"><code><html><body><span class="attribute">open</span> <span class="keyword">class</span> <span class="type">ScenarioViewController</span>: <span class="type">UIViewController</span>  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>The view controller to layout scenario's content.</p>

</div>
<section id="relationships">
    <h2 hidden>Relationships</h2>
        <figure>
    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
 "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 2.47.1 (20210417.1919)
 -->
<!-- Pages: 1 -->
<svg width="872pt" height="116pt"
 viewBox="0.00 0.00 872.00 116.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 112)">
<polygon fill="white" stroke="transparent" points="-4,4 -4,-112 868,-112 868,4 -4,4"/>
<!-- ScenarioViewController -->
<g id="node1" class="node class current">
<title>ScenarioViewController</title>
<g id="a_node1"><a xlink:href="https://playbook-ui.github.io/playbook-ios/ScenarioViewController" xlink:title="ScenarioViewController">
<path fill="none" stroke="black" stroke-width="3" d="M528,-108C528,-108 336,-108 336,-108 330,-108 324,-102 324,-96 324,-96 324,-84 324,-84 324,-78 330,-72 336,-72 336,-72 528,-72 528,-72 534,-72 540,-78 540,-84 540,-84 540,-96 540,-96 540,-102 534,-108 528,-108"/>
<text text-anchor="middle" x="432" y="-86.3" font-family="Menlo" font-size="14.00">ScenarioViewController</text>
</a>
</g>
</g>
<!-- UIViewController -->
<g id="node2" class="node unknown">
<title>UIViewController</title>
<path fill="none" stroke="black" d="M528,-36C528,-36 336,-36 336,-36 330,-36 324,-30 324,-24 324,-24 324,-12 324,-12 324,-6 330,0 336,0 336,0 528,0 528,0 534,0 540,-6 540,-12 540,-12 540,-24 540,-24 540,-30 534,-36 528,-36"/>
<text text-anchor="middle" x="432" y="-14.3" font-family="Menlo" font-size="14.00">UIViewController</text>
</g>
<!-- ScenarioViewController&#45;&gt;UIViewController -->
<g id="edge1" class="edge conformsTo">
<title>ScenarioViewController&#45;&gt;UIViewController</title>
<path fill="none" stroke="black" d="M432,-71.7C432,-63.98 432,-54.71 432,-46.11"/>
<polygon fill="black" stroke="black" points="435.5,-46.1 432,-36.1 428.5,-46.1 435.5,-46.1"/>
</g>
</g>
</svg>


    <figcaption hidden>Inheritance graph for ScenarioViewController.</figcaption>
</figure>
        <h3>Conforms To</h3>
<dl>
    <dt class="unknown"><code>UIViewController</code></dt>
</dl>
</section>
    <section id="initializers">
        <h2>Initializers</h2>

        <div role="article" class="initializer" id="scenarioviewcontroller.init(context:)">
    <h3>
        <code><a href="#scenarioviewcontroller.init(context:)">init(context:​)</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">init</span>(<span class="variable">context</span>: <a href="https://playbook-ui.github.io/playbook-ios/ScenarioContext"><span class="type">ScenarioContext</span></a>)  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Initialize a new scenario view controller with given context.</p>

</div>
<h4>Parameters</h4>

<table class="parameters">
  <thead hidden>
  <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
  </tr>
  </thead>
  <tbody>
    <tr>
    <th>context</th>
    <td><code class="type">Scenario​Context</code></td>
    <td><p>The context of scenario.</p>
</td>
</tr>
  </tbody>
</table>
</div>
<div role="article" class="initializer" id="scenarioviewcontroller.init(context:scenario:)">
    <h3>
        <code><a href="#scenarioviewcontroller.init(context:scenario:)">init(context:​scenario:​)</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="attribute">convenience</span> <span class="keyword">init</span>(<span class="variable">context</span>: <a href="https://playbook-ui.github.io/playbook-ios/ScenarioContext"><span class="type">ScenarioContext</span></a>, <span class="variable">scenario</span>: <a href="https://playbook-ui.github.io/playbook-ios/Scenario"><span class="type">Scenario</span></a>)  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Initialize a new scenario view controller with given context.</p>

</div>
<h4>Parameters</h4>

<table class="parameters">
  <thead hidden>
  <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
  </tr>
  </thead>
  <tbody>
    <tr>
    <th>context</th>
    <td><code class="type">Scenario​Context</code></td>
    <td><p>The context of scenario.</p>
</td>
</tr>
<tr>
    <th>scenario</th>
    <td><code class="type">Scenario</code></td>
    <td><p>A scenario to be displayed initially.</p>
</td>
</tr>
  </tbody>
</table>
</div>
<div role="article" class="initializer" id="scenarioviewcontroller.init?(coder:)">
    <h3>
        <code><a href="#scenarioviewcontroller.init?(coder:)">init?(coder:​)</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="attribute">@</span><span class="attribute">available</span>(*, <span class="variable">unavailable</span>)
    <span class="keyword">public</span> <span class="attribute">required</span> <span class="keyword">init</span>?(<span class="variable">coder</span>: <span class="type">NSCoder</span>)  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Unavailable initializer.</p>

</div>
</div>
    </section>
    <section id="properties">
        <h2>Properties</h2>

        <div role="article" class="variable" id="scenarioviewcontroller.context">
    <h3>
        <code><a href="#scenarioviewcontroller.context">context</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">let</span> <span class="variable">context</span>: <a href="https://playbook-ui.github.io/playbook-ios/ScenarioContext"><span class="type">ScenarioContext</span></a></body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>The context of scenario that indicating environments.</p>

</div>
</div>
<div role="article" class="variable" id="scenarioviewcontroller.scenario">
    <h3>
        <code><a href="#scenarioviewcontroller.scenario">scenario</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">var</span> <span class="variable">scenario</span>: <a href="https://playbook-ui.github.io/playbook-ios/Scenario"><span class="type">Scenario</span></a>?  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>The currently displayed scenario.</p>

</div>
</div>
<div role="article" class="variable" id="scenarioviewcontroller.contentviewcontroller">
    <h3>
        <code><a href="#scenarioviewcontroller.contentviewcontroller">content​View​Controller</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">private</span>(<span class="variable">set</span>) <span class="keyword">var</span> <span class="variable">contentViewController</span>: <span class="type">UIViewController</span>?  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>The view controller wrapping content of currently displayed scenario.</p>

</div>
</div>
<div role="article" class="variable" id="scenarioviewcontroller.shouldstatusbarhidden">
    <h3>
        <code><a href="#scenarioviewcontroller.shouldstatusbarhidden">should​Status​Bar​Hidden</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">var</span> <span class="variable">shouldStatusBarHidden</span> = <span class="keyword">false</span></body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Specifies whether the status bar should be hidden.</p>

</div>
</div>
<div role="article" class="variable" id="scenarioviewcontroller.disablesendappearancetransition">
    <h3>
        <code><a href="#scenarioviewcontroller.disablesendappearancetransition">disables​End​Appearance​Transition</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">var</span> <span class="variable">disablesEndAppearanceTransition</span> = <span class="keyword">false</span></body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Specifies whether the <code>endAppearanceTransition</code> should be call after transition.</p>

</div>
</div>
<div role="article" class="variable" id="scenarioviewcontroller.prefersstatusbarhidden">
    <h3>
        <code><a href="#scenarioviewcontroller.prefersstatusbarhidden">prefers​Status​Bar​Hidden</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="attribute">open</span> <span class="attribute">override</span> <span class="keyword">var</span> <span class="variable">prefersStatusBarHidden</span>: <span class="type">Bool</span>  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Specifies whether the view controller prefers the status bar to be hidden or shown.</p>

</div>
</div>
    </section>
    <section id="methods">
        <h2>Methods</h2>

        <div role="article" class="function" id="scenarioviewcontroller.endappearancetransition()">
    <h3>
        <code><a href="#scenarioviewcontroller.endappearancetransition()">end​Appearance​Transition()</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="attribute">open</span> <span class="attribute">override</span> <span class="keyword">func</span> <span class="function">endAppearanceTransition</span>()  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Tells the child controller its appearance changed.</p>

</div>
</div>
    </section>



        </article>
    </main>

    <footer>
        <p>
    Generated on <time datetime="2021-08-25T19:01:54+0900">August 25, 2021</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a> <span class="version">1.0.0-rc.1</span>.
</p>
    </footer>
</body>
</html>
